home *** CD-ROM | disk | FTP | other *** search
/ Mac Format 1996 April / MacFormat CD Edition MF36 (April 1996).iso / Shareware City / Developers / Tools Plus - GUI⁄Event libs / Tools Plus 2.6.1a Evaluat'n Kit / Tools Plus 2.6.1a / User Manual / 22-Special Routines < prev    next >
INI File  |  1994-09-17  |  10KB  |  363 lines

  1. [Display using Monaco 9]
  2.  
  3.  
  4. 22  Special Routines
  5. ````````````````````
  6.  
  7.  
  8. Use these routines with caution, or don’t use them!
  9. ```````````````````````````````````````````````````
  10.   The following routines should be used with caution, or not at all.  The “comments or special instructions” column explains if the routine can be used in a limited way, or if a Tools Plus equivalent should be used instead.  If the column is blank, the Macintosh toolbox routine should not be used at all.
  11.  
  12.   If Inside Macintosh states that a specific routine should not be called because it is automatically called by the system when it starts up, you need not reference that routine in this section.
  13.  
  14.   Some routines that are not listed here can be used, but they will require a pointer to a window.  Your application can use Tools Plus’s WindowPointer routine to determine a window’s pointer.
  15.  
  16.  
  17.  
  18.  
  19. Toolbox Routine   Comments or Special Instructions
  20. ```````````````   ``````````````````````````````````````````````````````
  21. AddResMenu        Use AppleMenu
  22.  
  23. AppendMenu        Use Menu
  24.  
  25. BackPat           A window's background pattern should never be changed
  26.                   from white
  27.  
  28. BringToFront
  29.  
  30. CheckItem         Use CheckMenu
  31.  
  32. ClearMenuBar
  33.  
  34. CloseWindow       Use WindowClose
  35.  
  36. CountMItems       Use MenuItemCount or PopUpItemCount
  37.  
  38. DeleteMenu        Use RemoveMenu or RemovePopUp
  39.  
  40. DelMenuItem       Use RemoveMenu or RemovePopUp
  41.  
  42. DialogSelect      Modal dialogs are allowed, but a Tools Plus window is
  43.                   easier to use
  44.  
  45. DisableItem       Use EnableMenu
  46.  
  47. DisposeControl    Use with custom controls only
  48.  
  49. DisposeMenu
  50.  
  51. DisposeWindow
  52.  
  53. DlgCopy
  54.  
  55. DlgCut
  56.  
  57. DlgDelete
  58.  
  59. DlgPaste
  60.  
  61. DragControl       Use with custom controls only
  62.  
  63. DragWindow
  64.  
  65. Draw1Control      Use with custom controls only
  66.  
  67. DrawGrowIcon
  68.  
  69. DrawMenuBar       Use UpdateMenuBar
  70.  
  71. EnableItem        Use EnableMenu or EnablePopUp
  72.  
  73. EventAvail        Your application will intercept some events so that
  74.                   they never reach Tools Plus.  Also note that under
  75.                   MultiFinder and System 7, this routine will switch
  76.                   tasks to other applications and desk accessories.
  77.                      Don’t use this routine unless you really know what
  78.                   you are doing and you thoroughly test your results.
  79.  
  80. FindControl       Done automatically for buttons and scroll bars
  81.  
  82. FindWindow
  83.  
  84. FlashMenuBar
  85.  
  86. FlushEvents       InitToolsPlus flushes all events when Tools Plus is
  87.                   initialized.  You may flush mouse-down, mouse-up, key-
  88.                   down, key-up and auto-key events, as well as
  89.                   application-defined events 1 through 4.  When flushing
  90.                   mouse-up events, you may be disrupting a drag that is
  91.                   already in progress.  If the StillDown function
  92.                   returns true, a drag is in progress, and PollSystem
  93.                   will continue processing the drag until a mouse-up
  94.                   event is encountered.
  95.                      As a rule, don’t use this routine unless you really
  96.                   know what you are doing and you thoroughly test your
  97.                   results.
  98.  
  99. FrontWindow       This routine is almost useless if your application has
  100.                   a tool bar or floating palettes.  See ToolBarNumber,
  101.                   FirstPaletteNumber, FirstStdWindowNumber, and
  102.                   WorkWindowNumber
  103.  
  104. GetCRefCon        Use with custom controls only
  105.  
  106. GetCTitle         Use with custom controls only
  107.  
  108. GetCtlMax         Use with custom controls only.  For scroll bars, use
  109.                   GetScrollBarMax
  110.  
  111. GetCtlMin         Use with custom controls only.  For scroll bars, use
  112.                   GetScrollBarMin
  113.  
  114. GetCtlValue       Use with custom controls only.  For scroll bars, use
  115.                   GetScrollBarVal.  For buttons (check boxes or radio
  116.                   buttons), use ButtonIsSelected
  117.  
  118. GetItem           Use GetMenuString
  119.  
  120. GetItemCmd        Use GetMenuCmd
  121.  
  122. GetItemIcon       Use GetMenuIcon or GetPopUpIcon
  123.  
  124. GetItemMark       Use GetMenuMark or GetPopUpMark
  125.  
  126. GetMenu           No equivalent in Tools Plus because menus can’t be
  127.                   defined as resources.  Use Menu instead or NewPopUp.
  128.  
  129. GetNewControl     No equivalent in Tools Plus because buttons and scroll
  130.                   bars can’t be defined as resources.  Use NewButton or
  131.                   NewScrollBar instead.  Can be used for custom
  132.                   controls.
  133.  
  134. GetNewMBar        No equivalent in Tools Plus because menus can’t be
  135.                   defined as resources.  Use Menu instead or NewPopUp.
  136.  
  137. GetNewWindow      No equivalent in Tools Plus because windows can’t be
  138.                   defined as resources.  Use WindowOpen, WindowOpenRect,
  139.                   or ToolBarOpen instead.
  140.  
  141. GetNextEvent      Your application will intercept events so that they
  142.                   never reach Tools Plus.  Also note that under
  143.                   MultiFinder and System 7, this routine will switch
  144.                   tasks to other applications and desk accessories.
  145.                      Don’t use this routine unless you really know what
  146.                   you are doing and you thoroughly test your results.
  147.  
  148. GetOSEvent        Your application will intercept events so that they
  149.                   never reach Tools Plus.  Also note that under
  150.                   MultiFinder and System 7, this routine will switch
  151.                   tasks to other applications and desk accessories.
  152.                      As a rule, don’t use this routine unless you really
  153.                   know what you are doing and you thoroughly test your
  154.                   results.
  155.  
  156. GrowWindow
  157.  
  158. HideControl       Use with custom controls only
  159.  
  160. HideWindow        Use WindowDisplay
  161.  
  162. HiliteControl     Use with custom controls only.  For scroll bars, use
  163.                   EnableScrollBar.  For buttons, use EnableButton.
  164.  
  165. HiliteMenu        Use MenuHilite
  166.  
  167. HiliteWindow
  168.  
  169. InitCursor        Use CursorShape or ResetCursor routines instead
  170.  
  171. InitDialogs
  172.  
  173. InitMenus         Not required in THINK Pascal
  174.  
  175. InitWindows
  176.  
  177. InsertMenu        Use Menu or NewPopUp
  178.  
  179. InsertResMenu
  180.  
  181. InsMenuItem       Use InsertMenuItem
  182.  
  183. IsDialogEvent     Modal dialogs are allowed, but a Tools Plus window is
  184.                   easier to use
  185.  
  186. KillControls
  187.  
  188. List Manager      List Manager routines may be incorporated into your
  189.                   application to handle sophisticated lists.  However,
  190.                   the list’s scroll bars must be flagged as “custom
  191.                   controls,” and your application must handle all events
  192.                   pertaining to the list.
  193.  
  194. MenuKey
  195.  
  196. MenuSelect
  197.  
  198. MoveControl       Use with custom controls only
  199.  
  200. MovePortTo        The co-ordinates may be changed temporarily, providing
  201.                   they are reset prior to calling any Tools Plus routine
  202.  
  203. MoveWindow        Use WindowMove
  204.  
  205. NewControl        Use with custom controls only.  For scroll bars, use
  206.                   NewScrollBar.  For buttons, use NewButton
  207.  
  208. NewMenu           Use Menu or NewPopUp
  209.  
  210. NewWindow         WindowOpen, WindowOpenRect, or ToolBarOpen
  211.  
  212. NMInstall         Use SetNotification and PostNotification
  213.  
  214. NMRemove          Executed automatically (if required) when your
  215.                   application is activated
  216.  
  217. OpenDeskAcc
  218.  
  219. PopUpMenuSelect
  220.  
  221. PostEvent         Do not post app4Evt (or osEvt in System 7) events.
  222.                   They are used by MultiFinder.  They are used by
  223.                   MultiFinder and System 7’s Finder.
  224.  
  225. SelectWindow      Use ActivateWindow
  226.  
  227. SendBehind
  228.  
  229. SetCRefCon        Use with custom controls only
  230.  
  231. SetCTitle         Use with custom controls only.  For buttons, use
  232.                   ButtonTitle
  233.  
  234. SetCtlMax         Use with custom controls only.  For scroll bars, use
  235.                   SetScrollBarMax
  236.  
  237. SetCtlMin         Use with custom controls only.  For scroll bars, use
  238.                   SetScrollBarMin
  239.  
  240. SetCtlValue       Use with custom controls only.  For scroll bars, use
  241.                   SetScrollBarVal.  For buttons (check boxes or radio
  242.                   buttons), use SelectButton.
  243.  
  244. SetCursor         Use CursorShape or ResetCursor routines instead
  245.  
  246. SetEventMask      Upon startup, key-up events are disabled.  Do not
  247.                   disable the following events: mouseDown, MouseUp,
  248.                   keyDown, autoKey, updateEvt, activateEvt, and app4Evt
  249.  
  250. SetItem           Use RenameItem or RenamePopUp
  251.  
  252. SetItemCmd        Use MenuCmd
  253.  
  254. SetItemIcon       Use MenuIcon or PopUpIcon
  255.  
  256. SetItemMark       Use MenuMark or PopUpMark
  257.  
  258. SetItemStyle      Use MenuStyle or PopUpStyle
  259.  
  260. SetMenuBar
  261.  
  262. SetOrigin         The co-ordinates may be changed temporarily, providing
  263.                   they are reset to (0,0) prior to calling any Tools
  264.                   Plus routine
  265.  
  266. SetResLoad        Must be set to SetResLoad(true) before calling any
  267.                   Tools Plus routine
  268.  
  269. SetWTitle         Use WindowTitle
  270.  
  271. ShowControl       Use with custom controls only
  272.  
  273. ShowHide          Use WindowDisplay
  274.  
  275. ShowWindow        Use WindowDisplay
  276.  
  277. SizeControl       Use with custom controls only
  278.  
  279. SizeWindow        Use WindowSize
  280.  
  281. SpaceExtra        SpaceExtra must be set to 0, the initial value, when
  282.                   calling any Tools Plus routine
  283.  
  284. SysBeep           Use Beep (for convenience)
  285.  
  286. SystemClick
  287.  
  288. SystemEdit
  289.  
  290. SystemEvent
  291.  
  292. SystemMenu
  293.  
  294. TEActive          Use ActivateField
  295.  
  296. TEAutoView
  297.  
  298. TECalc
  299.  
  300. TEClick           Use ClickInField
  301.  
  302. TECopy
  303.  
  304. TECut
  305.  
  306. TEDeactivate      Use DeactivateField
  307.  
  308. TEDelete
  309.  
  310. TEDispose         Use DeleteField
  311.  
  312. TEFromScrap
  313.  
  314. TEGetText         Use GetFieldString
  315.  
  316. TEIdle            Called in PollSystem
  317.  
  318. TEInit
  319.  
  320. TEInsert
  321.  
  322. TEKey
  323.  
  324. TENew             Use NewField
  325.  
  326. TEPaste
  327.  
  328. TEPinScroll
  329.  
  330. TEScroll
  331.  
  332. TESelect
  333.  
  334. TESelView
  335.  
  336. TESetJust
  337.  
  338. TESetText
  339.  
  340. TEToScrap
  341.  
  342. TEUpdate
  343.  
  344. TrackBox
  345.  
  346. TrackControl      Done automatically for buttons and scroll bars
  347.  
  348. TrackGoAway
  349.  
  350. UnloadSeg         Do not unload the segments containing Tools Plus’s
  351.                   libraries
  352.  
  353. UpdtControl
  354.  
  355. WaitNextEvent     Your application will intercept events so that they
  356.                   never reach Tools Plus.  Also note that under
  357.                   MultiFinder and System 7, this routine will switch
  358.                   tasks to other applications and desk accessories.
  359.                      Don’t use this routine unless you really know what
  360.                   you are doing and you thoroughly test your results.
  361.  
  362. ZoomWindow
  363.